Skip to content

docs: update documentation for today's changes#70

Merged
CalvinAllen merged 1 commit into
mainfrom
docs/update-commit-conventions
Dec 9, 2025
Merged

docs: update documentation for today's changes#70
CalvinAllen merged 1 commit into
mainfrom
docs/update-commit-conventions

Conversation

@CalvinAllen

Copy link
Copy Markdown
Contributor

Summary

Updates documentation to reflect changes made today:

Commit Convention Updates (docs/COMMIT_CONVENTION.md)

  • Document that PR titles must follow conventional commit format (squash merge workflow)
  • Add section explaining squash merge process
  • Update subject rules to allow uppercase abbreviations (PR, API, CLI, URL, etc.)

Contributing Guide Updates (CONTRIBUTING.md)

  • Add note about squash merges and PR title requirements
  • Update commit validation description

README Updates

  • Update list command: now optional runtime argument, shows all installed versions with (global) indicator
  • Update current command: clarify it shows all runtimes when no argument given
  • Update command reference table

Test plan

  • Review documentation for accuracy
  • Verify links work correctly

- Document that PR titles must follow conventional commit format
- Add section explaining squash merge process
- Update subject rules to allow uppercase abbreviations (PR, API, CLI)
- Update CONTRIBUTING.md with squash merge notes
@CalvinAllen CalvinAllen merged commit da237dd into main Dec 9, 2025
9 checks passed
@CalvinAllen CalvinAllen deleted the docs/update-commit-conventions branch December 9, 2025 22:19
@CalvinAllen

Copy link
Copy Markdown
Contributor Author

/skip-changelog

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

1 participant